home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIStreamLoader.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.4 KB  |  93 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39. #include "nsIChannel.idl"
  40.  
  41. interface nsIRequest;
  42. interface nsIURI;
  43. interface nsILoadGroup;
  44. interface nsIStreamLoader;
  45. interface nsIInterfaceRequestor;
  46.  
  47. [scriptable, uuid(359F7990-D4E9-11d3-A1A5-0050041CAF44)]
  48. interface nsIStreamLoaderObserver : nsISupports
  49. {
  50.     void onStreamComplete(in nsIStreamLoader loader,
  51.                           in nsISupports ctxt,
  52.                           in nsresult status,
  53.                           in unsigned long resultLength,
  54.                           [const,array,size_is(resultLength)] in octet result);
  55. };
  56.  
  57. /**
  58.  * Asynchronously loads a channel into a memory buffer.
  59.  *
  60.  * XXX define behaviour for sizes >4 GB
  61.  */
  62. [scriptable, uuid(31d37360-8e5a-11d3-93ad-00104ba0fd40)]
  63. interface nsIStreamLoader : nsISupports
  64. {
  65.     /**
  66.      * Initialize this stream loader, and start loading the data.
  67.      *
  68.      * @param aChannel
  69.      *        A Channel to load data from. This must not be asyncOpen'd yet!
  70.      * @param aObserver
  71.      *        An observer that will be notified when the data is complete.
  72.      * @param aContext
  73.      *        May be null. Will be passed to the observer.
  74.      *
  75.      * @note Failure to open the channel will be indicated by an async callback
  76.      *       to the observer.
  77.      */
  78.     void init(in nsIChannel aChannel,
  79.               in nsIStreamLoaderObserver aObserver,
  80.               in nsISupports aContext);
  81.  
  82.     /**
  83.      * Gets the number of bytes read so far.
  84.      */
  85.     readonly attribute unsigned long numBytesRead;
  86.  
  87.     /**
  88.      * Gets the request that loaded this file.
  89.      * null after the request has finished loading.
  90.      */
  91.     readonly attribute nsIRequest request;
  92. };
  93.